/*
 * Copyright (c) 2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_DEQUE_H_INCLUDED_
#define ALKES_DEQUE_H_INCLUDED_

#include "alkes/internal.h"
#include "alkes/core/DequeIterator.h"
#include "alkes/core/DequeIteratorFactory.h"

namespace alkes {

/// \addtogroup core
//@{

class AL_EXPORT Deque
{
public:

    typedef DequeIterator* Iterator;

    Deque(DequeIteratorFactory* factory = 0);
    ~Deque();

    // Utility.
    int32_t count() const;
    int32_t index(void* object) const;
    int32_t index(Iterator iter) const;

    // Add object.
    bool push(void* object);
    bool unshift(void* object);
    bool insert(int32_t idx, void* object);
    bool insert(Iterator iter, void* object);

    // Remove object.
    void* pop();
    void* shift();
    bool remove(void* object);
    bool remove(Iterator iter);
    void clear();

    // Get iterator.
    Iterator getLast();
    const Iterator getLast() const;
    Iterator getFirst();
    const Iterator getFirst() const;
    Iterator iterator(int32_t idx);
    const Iterator iterator(int32_t idx) const;
    Iterator find(void* object);
    const Iterator find(void* object) const;

private:
    inline void setLast(Iterator iter);
    inline void setFirst(Iterator iter);

    Iterator getIterator(int32_t idx) const;
    Iterator findIterator(void* object) const;
    Iterator createIterator(void* object, Iterator prev, Iterator next);
    void destroyIterator(Iterator iter);

private:
    int32_t count_;
    Iterator first_;
    Iterator last_;
    DequeIteratorFactory* factory_;
};

//@}

}

#endif
